Crate nu_protocol

Modules

hir

Macros

errln	Outputs to standard error
out	Outputs to standard out
outln	Outputs to standard out with a newline added

Structs

CallInfo	Associated information for the call of a command, including the args passed to the command and a tag that spans the name of the command being called
ColumnPath	The fundamental path primitive to descrive how to navigate through a table to get to a sub-item. A path member can be either a word or a number. Words/strings are taken to mean a column name, and numbers are the row number. Taken together they describe which column or row to narrow to in order to get data.
Dictionary	A dictionary that can hold a mapping from names to Values
EvaluatedArgs	The set of positional and named arguments, after their values have been evaluated.
PathMember	A basic piece of a ColumnPath, which describes the steps to take through a table to arrive a cell, row, or inner table
Range	The range definition, holding the starting and end point of the range
RowType	A shape representation of the type of a row
Scope	An evaluation scope. Scopes map variable names to Values and aid in evaluating blocks and expressions. Additionally, holds the value for the special $it variable, a variable used to refer to the value passing through the pipeline at that moment
Signature	The full signature of a command. All commands have a signature similar to a function signature. Commands will use this information to register themselves with Nu's core engine so that the command can be invoked, help can be displayed, and calls to the command can be error-checked.
TaggedDictBuilder	A helper to help create dictionaries for you. It has the ability to insert values into the dictionary while maintaining the tags that need to be applied to the individual members
Value	The fundamental structured value that flows through the pipeline, with associated metadata

Enums

CommandAction	The inner set of actions for the command processor. Each denotes a way to change state in the processor without changing it directly from the command itself.
MaybeOwned	Helper type to allow passing something that may potentially be owned, but could also be borrowed
NamedType	The types of named parameter that a command can have
PositionalType	The type of positional arguments
Primitive	The most fundamental of structured values in Nu are the Primitive values. These values represent types like integers, strings, booleans, dates, etc that are then used as the buildig blocks to build up more complex structures.
RangeInclusion	The two types of ways to include a range end. Inclusive means to include the value (eg 1..3 inclusive would include the 3 value). Exclusive excludes the value (eg 1..3 exclusive does not include 3 value)
ReturnSuccess	The fundamental success type in the pipeline. Commands return these values as their main responsibility
SyntaxShape	The syntactic shapes that values must match to be passed into a command. You can think of this as the type-checking that occurs when you call a function.
Type	Representation of for the type of a value in Nu
UnspannedPathMember	A PathMember that has yet to be spanned so that it can be used in later processing
UntaggedValue	The core structured values that flow through a pipeline

Traits

PrettyType	A trait to enable pretty-printing of type information
ShellTypeName	A trait that allows structures to define a known .type_name() which pretty-prints the type
SpannedTypeName	A trait that allows structures to define a known way to return a spanned type name

Functions

did_you_mean	Prepares a list of "sounds like" matches for the string you're trying to find
format_date	Format a UTC date value into a humanized string (eg "1 week ago" instead of a formal date string)
format_duration	Format a duration in nanoseconds into a string
format_primitive	Format a Primitive value into a string
merge_descriptors

Type Definitions

ReturnValue

The core Result type for pipelines